[ML] Extract apiDoc params from the schema definitions #62933

darnautov · 2020-04-08T11:20:52Z

Summary

Extracts apiDoc parameters from the schema definition with the custom worker. Please check x-pack/plugins/ml/server/routes/README.md for instructions to generate the documentation locally.

elasticmachine · 2020-04-08T11:20:55Z

Pinging @elastic/ml-ui (:ml)

peteharverson · 2020-04-08T16:32:37Z

You can end up with duplicated parameters sections, where they are defined with @apiParam in the route and in the schema. Also some of the formatting in the cells looks a bit odd (### Parameters and :---------)

@apiParam

peteharverson · 2020-04-08T16:36:36Z

Is there a way of removing the duplicate 'Parameters' label?

peteharverson · 2020-04-08T16:45:23Z

For the Instantiate an anomaly detection job route, should the analysis_config parameter have a separate entry in the table, like say datafeed_config has:

peteharverson · 2020-04-14T14:14:11Z

x-pack/plugins/ml/server/routes/anomaly_detectors.ts

@@ -315,8 +310,6 @@ export function jobRoutes({ router, mlLicense }: RouteInitialization) {
   * @api {post} /api/ml/anomaly_detectors/_validate/detector Validate detector
   * @apiName ValidateAnomalyDetector
   * @apiDescription Validates specified detector.


This needs an @apiSchema param.

indeed, but it has not been described yet (schema.any())

x-pack/plugins/ml/server/routes/indices.ts

x-pack/plugins/ml/server/routes/job_service.ts

# Conflicts: # yarn.lock

alvarezmelissa87 · 2020-04-14T23:29:33Z

How should the version be specified? All the versions are at 0.0 right now.

alvarezmelissa87

Gave this a test and LGTM ⚡ Just left a small question.

darnautov · 2020-04-15T09:26:15Z

@elasticmachine merge upstream

walterra · 2020-04-15T10:25:21Z

It looks like even if we only have a package.json in the ML plugin folder, this updates the overall yarn.lock file in Kibana's root. I wonder if we have an audit process in place for adding a lot of new dependencies like this? (I didn't spot yarn.lock being part of CODEOWNERS maybe that's something worth doing so changing dependencies gives people involved more visibility? Not something for this PR but more of a general suggestion/question)

peteharverson

Tested latest edits and LGTM. Please double check that the KIbana platform / operations are happy with our dedicated package.json before merging.

mistic

Changes on the files under operations team code owners LGTM

This reverts commit 07f0680

kibanamachine · 2020-04-15T16:36:58Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 0160f0c

History

💔 Build #40954 failed 07f0680
💔 Build #40925 failed 9651853
💔 Build #40900 failed d4b7b54
💔 Build #40893 failed d4b7b54
💔 Build #40889 failed b05b7bd

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* [ML] WIP apiDoc schema extractor * [ML] extract actual type * [ML] refactor schema definitions * [ML] Update README.md * [ML] extract nested * [ML] call job validation endpoint with complete payload * [ML] escape special chars and fix line breaks * [ML] clean up extractDocEntries * [ML] serializeWithType * [ML] add missing annotations * [ML] fix parent schema assigment * [ML] support object composition * [ML] support multiple schemas per block * [ML] fix for collections * [ML] fix calendarIdsSchema * [ML] add ml package.json with apidoc commands * [ML] use the single output markdown file * [ML] fix typo * [ML] change the Calendars order * [ML] adjust the order in adidoc.json * [ML] update api version * [ML] update tsconfig.json include * [ML] update packages/kbn-pm/dist/index.js * [ML] update ML overrides in .eslintrc.js * [ML] yarn.lock symlink * Revert "[ML] yarn.lock symlink" This reverts commit 07f0680 Co-authored-by: Elastic Machine <[email protected]>

…#63663) * [ML] Extract apiDoc params from the schema definitions (#62933) * [ML] WIP apiDoc schema extractor * [ML] extract actual type * [ML] refactor schema definitions * [ML] Update README.md * [ML] extract nested * [ML] call job validation endpoint with complete payload * [ML] escape special chars and fix line breaks * [ML] clean up extractDocEntries * [ML] serializeWithType * [ML] add missing annotations * [ML] fix parent schema assigment * [ML] support object composition * [ML] support multiple schemas per block * [ML] fix for collections * [ML] fix calendarIdsSchema * [ML] add ml package.json with apidoc commands * [ML] use the single output markdown file * [ML] fix typo * [ML] change the Calendars order * [ML] adjust the order in adidoc.json * [ML] update api version * [ML] update tsconfig.json include * [ML] update packages/kbn-pm/dist/index.js * [ML] update ML overrides in .eslintrc.js * [ML] yarn.lock symlink * Revert "[ML] yarn.lock symlink" This reverts commit 07f0680 Co-authored-by: Elastic Machine <[email protected]> * update packages/kbn-pm/dist/index.js Co-authored-by: Elastic Machine <[email protected]>

* master: (56 commits) [i18n] Update CODEOWNERS (elastic#63354) add platform team definition of done (elastic#59993) [SIEM] move away from Joi for importing/exporting timeline (elastic#62125) Fix discover preserve url (elastic#63580) [alerting] Adds an alertServices mock and uses it in siem, monitoring and uptime (elastic#63489) Closes elastic#63109 for Service Map by resetting edges styles for the selected node (elastic#63655) MIgrated index_header to react (elastic#63490) Index pattern management UI -> TypeScript and New Platform Ready (indexed_fields_table) (elastic#63364) [SIEM] [Cases] Insert timeline and reporters/tags in table bug fixes (elastic#63642) [Reporting] Make usable default element positions (elastic#63191) [Reporting] Switch Serverside Config Wrapper to NP (elastic#62500) [Reporting] Add "warning" status as an alternate type of completed job (elastic#63498) Split action types into own page (elastic#63516) [Lens] Only show copy on save for previously saved docs (elastic#63535) Update README.md (elastic#63622) Bugfix clear saved query crashes kibana on Discover in some cases (elastic#63554) Add uptime CODEOWNER entries. (elastic#63616) [ML] Extract apiDoc params from the schema definitions (elastic#62933) Fix alerting documentation encryption key requirement (elastic#63512) Fix CODEOWNERS and sass lint paths (elastic#63552) ...

darnautov added 5 commits April 8, 2020 13:14

[ML] WIP apiDoc schema extractor

011edc2

[ML] extract actual type

4ef204c

[ML] refactor schema definitions

95827f7

[ML] Update README.md

4230d93

[ML] extract nested

4cd0f09

darnautov added :ml v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.8.0 labels Apr 8, 2020

darnautov requested review from alvarezmelissa87 and peteharverson April 8, 2020 11:20

darnautov self-assigned this Apr 8, 2020

darnautov added 10 commits April 9, 2020 10:56

[ML] call job validation endpoint with complete payload

1108ecf

[ML] escape special chars and fix line breaks

afbd0c7

[ML] clean up extractDocEntries

9c45092

[ML] serializeWithType

abebb69

[ML] add missing annotations

d50da55

[ML] fix parent schema assigment

2ff4843

[ML] support object composition

0a03db4

Merge remote-tracking branch 'upstream/master' into ML-apiDoc-gen

e3ee24e

[ML] support multiple schemas per block

2d37294

[ML] fix for collections

78cf4c9

darnautov marked this pull request as ready for review April 10, 2020 16:33

darnautov requested a review from a team as a code owner April 10, 2020 16:33

darnautov requested review from walterra and jgowdyelastic April 10, 2020 16:33

peteharverson reviewed Apr 14, 2020

View reviewed changes

darnautov added 5 commits April 14, 2020 17:19

Merge remote-tracking branch 'upstream/master' into ML-apiDoc-gen

af0de0e

# Conflicts: # yarn.lock

[ML] use the single output markdown file

cb3e285

[ML] fix typo

ec9f680

[ML] change the Calendars order

7ac83a4

[ML] adjust the order in adidoc.json

2195ecb

darnautov requested a review from peteharverson April 14, 2020 16:33

alvarezmelissa87 approved these changes Apr 14, 2020

View reviewed changes

[ML] update api version

ab83920

elasticmachine and others added 3 commits April 15, 2020 05:26

Merge branch 'master' into ML-apiDoc-gen

b05b7bd

[ML] update tsconfig.json include

ee5c26c

Merge remote-tracking branch 'origin/ML-apiDoc-gen' into ML-apiDoc-gen

d4b7b54

peteharverson approved these changes Apr 15, 2020

View reviewed changes

[ML] update packages/kbn-pm/dist/index.js

9651853

darnautov requested a review from a team as a code owner April 15, 2020 11:45

mistic approved these changes Apr 15, 2020

View reviewed changes

darnautov added 3 commits April 15, 2020 15:30

[ML] update ML overrides in .eslintrc.js

f429087

[ML] yarn.lock symlink

07f0680

Revert "[ML] yarn.lock symlink"

0160f0c

This reverts commit 07f0680

darnautov merged commit 7058070 into elastic:master Apr 15, 2020

darnautov deleted the ML-apiDoc-gen branch April 16, 2020 07:17

darnautov mentioned this pull request Apr 16, 2020

[7.x] [ML] Extract apiDoc params from the schema definitions (#62933) #63663

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Extract apiDoc params from the schema definitions #62933

[ML] Extract apiDoc params from the schema definitions #62933

darnautov commented Apr 8, 2020 •

edited

Loading

elasticmachine commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson Apr 14, 2020

darnautov Apr 14, 2020

alvarezmelissa87 commented Apr 14, 2020

alvarezmelissa87 left a comment

darnautov commented Apr 15, 2020

walterra commented Apr 15, 2020

peteharverson left a comment

mistic left a comment

kibanamachine commented Apr 15, 2020

[ML] Extract apiDoc params from the schema definitions #62933

[ML] Extract apiDoc params from the schema definitions #62933

Conversation

darnautov commented Apr 8, 2020 • edited Loading

Summary

elasticmachine commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson commented Apr 8, 2020

peteharverson Apr 14, 2020

Choose a reason for hiding this comment

darnautov Apr 14, 2020

Choose a reason for hiding this comment

alvarezmelissa87 commented Apr 14, 2020

alvarezmelissa87 left a comment

Choose a reason for hiding this comment

darnautov commented Apr 15, 2020

walterra commented Apr 15, 2020

peteharverson left a comment

Choose a reason for hiding this comment

mistic left a comment

Choose a reason for hiding this comment

kibanamachine commented Apr 15, 2020

💚 Build Succeeded

History

darnautov commented Apr 8, 2020 •

edited

Loading